ENG-4325: Guard nil rack.input for Rack 3 compatibility#3
Open
remmons wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ENG-4325
Purpose
Make the gem compatible with Rack 3. Under Rack 3,
env["rack.input"]is no longer guaranteed to be present — it isnilfor bodyless requests (e.g.GET), whereas Rack 2 always supplied an emptyStringIO. The doc generators call.rewindon it unconditionally, so everyGETexample raisedNoMethodError: undefined method 'rewind' for niland failed to document.This blocks the Rack 2 → 3 upgrade in
promote(ENG-4325) — all 13*/doc_spec.rbAPI-doc specs there fail without it.Approach
Treat a
nilrack.inputas an empty body in both readers:ClientBase#read_request_body—return "" if input.nil?beforerewind/read.TestServer#call— guard therewind/readofenv["rack.input"](same nil case).No behavior change on Rack 2 (input is always present there); on Rack 3 a bodyless request now documents an empty body instead of crashing.
Testing
Verified against
promote's Rack 3.1.21 branch with this fork pointed in via a localpath:override: all 13doc_spec.rbexamples pass (were 13/13 failing withrewind for nil).